Northern Region Patient Demographics FHIR API icon

Northern Region Patient Demographics FHIR API

(0 reviews)

FHIR Practitioner Data Guide

DATA ELEMENTSDATA TYPECARDINALITYSAMPLE VALUEAVAILABILITYCOMMENTS
resourceTypePractitionerRole0..*"Practitioner"All DHBsFixed Value
idstring0..1"44446"All DHBsFor ADHB, this contains the Practitioner unique identifier. For CMH, NDHB and WDHB, this is the same value as Practitioner.identifier.value, which contains the HPI-CPN.
metaMeta0..1All DHBs
````meta.versionIdid0..1"0.4.5"All DHBsIndicates the Patient IG version number.
````meta.lastUpdatedinstant0..1All DHBsThe version of the patient record in PAS is not kept. Source data is also derived from several tables in source. So, timestamp may be different per table.
````meta.sourceuri0..1"CMS"All DHBs"Identifies the PAS system where information was drawn from. Value is "CMS" for ADHB, "WebPAS" for NDHB and "iPM" for CMH and WDHB."
````meta.profilecanonical(Structure Definition)0..*(see comments)All DHBsFixed Value: http://hl7.org.nz/fhir/StructureDefinition/NorthernRegionPatient
````meta.security.codecode0..1"N"All DHBsFixed Value
````meta.security.displaystring0..1"Normal"All DHBsFixed Value
identifier[i]Identifier0..*All DHBs
````identifier: HPIIdentifier0..1All DHBs
````````identifier.usecode1..1"official"All DHBsFixed Value
````````identifier.typeCodeableConcept0..1All DHBs
````````````identifier.type.coding.systemuri0..1(see comments)All DHBsFixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
````````````identifier.type.codecode0..1"HPI_CPN"All DHBsFixed Value
````````````identifier.type.displaystring0..1"HPI_CPN"All DHBsFixed Value
```````````identifier.type.textstring0..1"HPI_CPN"All DHBsFixed Value
````````identifier.systemuri0..1(see comments)All DHBsFixed Value: https://standards.digital.health.nz/ns/hpi-person-id
````````identifier valuestring0..1"10AWSK"All DHBsFor CMH, NDHB and WDHB, this is the same value as Practitioner.id.
````identifier: dormantHPIIdentifier0..1n/aThis is a placeholder element and presently not used by any of the 4 DHBs.
name[i]HumanName1..*All DHBs
````preferred nameExtension: Boolean0..*ADHBPreferred name of the general practitioner.
````````preferred name.urluri1..1(see comments)ADHBFixed Value: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
````````preferred name.valueboolean0..1trueADHBPossible values are true or false
````name.usecode0..1"official"All DHBs"For CMH, NDHB and WDBH, this field is always set to "usual". ADHB can have both official name and preferred name of the practitioner. ADHB practitioner preferred name will always have "usual" as the name.use value."
````name.textstring0..1"Dr Benjamin Mark Comery"All DHBsThis is a concatenation of practitioner name prefix (title), give names and family name.
````name.familystring0..1"Comery"All DHBsContains the surname of the practitioner.
````name.given[x]string0..*"Benjamin Mark"All DHBsFor ADHB, WDHB and CMH, a practitioner can have up to 3 given names. For NDHB, only one practitioner given name is provided.
````name.prefix[x]string0..*"Dr"All DHBsContains the title of the practitioner.
gendercode1..1"unknown"CMH, NDHB, WDHB"Possible values are "female", "male", "unknown". "other" is presently not used. Practitioner gender is not available in ADHB."
qualification[i]BackboneElement0..*All DHBsCertification, licenses, or training pertaining to the provision of care
````qualification.idCodeableConcept1..1n/aThis is a placeholder element and presently not used by any of the 4 DHBs.
````qualification.registration-status-codeCodeableConcept1..1n/aAn indicator of the practicing status of the practitioner as supplied by their Responsible Authority or professional body. This is a placeholder element and presently not used by any of the 4 DHBs.
````````registration-status-code.statusn/aThis is a placeholder element and presently not used by any of the 4 DHBs.
````````````registration-status-code.status.systemuri0..1(see comments)n/aFixed Value: https://standards.digital.health.nz/ns/practitioner-registration-status-code. This is a placeholder element and presently not used by any of the 4 DHBs.
````````````registration-status-code.status.codecode0..1"MD"n/aFixed Value. This is a placeholder element and presently not used by any of the 4 DHBs.
````````````registration-status-code.status.displaystring0..1"Medical License number"n/aFixed Value. This is a placeholder element and presently not used by any of the 4 DHBs.
````````````registration-status-code.status.textstring0..1"Medical License number"n/aFixed Value. This is a placeholder element and presently not used by any of the 4 DHBs.
````````qualification.registration-periodCodeableConcept1..1n/aThis is a placeholder element and presently not used by any of the 4 DHBs.
````````````qualification.registration-period.urluri1..1"period"n/aFixed Value. This is a placeholder element and presently not used by any of the 4 DHBs.
````````````qualification.registration-period.value.startdateTimen/aThis is a placeholder element and presently not used by any of the 4 DHBs.
````````````qualification.registration-period.value.enddateTime0..1n/aExpiry date of the Medical License Number. This is a placeholder element and presently not used by any of the 4 DHBs.
````````qualification.registration-status-code.urluri1..1(see comments)n/aFixed Value: http://hl7.org.nz/fhir/StructureDefinition/registration-status-code
````qualification.scope_of_practiceComplex1..1NDHBThe type or range of health services a practitioner is authorised to perform, as determined by the Responsible Authority or professional body.
````````qualification.scope_of_practice.codeNDHB
````````````scope_of_practice.code.urluri1..1"code"NDHBFixed Value
````````````scope_of_practice.code.systemuri0..1(see comments)NDHBFixed Value: https://standards.digital.health.nz/ns/practitioner-scope-of-practice
````````````scope_of_practice.code.codecode0..1"GP"NDHB
````````````scope_of_practice.code.displaystring0..1"General Practice"NDHB
````````````scope_of_practice.code.textstring0..1"General Practice"NDHBSame as display value.
````````qualification.scope_of_practice.periodCodeableConcept1..1NDHB
````````````scope_of_practice.period.urluri1..1"period"NDHBFixed Value
````````````scope_of_practice.period.value.startdateTimeNDHB
````````````scope_of_practice.period.value.enddateTime0..1NDHBnot used
````````qualification.scope_of_practice.urluri1..1(see comments)NDHBFixed Value: http://hl7.org.nz/fhir/StructureDefinition/scope-of-practice
````qualification.condition_on_practiceComplex1..1n/aA full description of the conditions the health practitioner is subject to in relation to their scope of practice. This is a placeholder element and presently not used by any of the 4 DHBs.
````````qualification.condition_on_practice.coden/aThis is a placeholder element and presently not used by any of the 4 DHBs.
````````````scope_of_practice.period.urluri1..1"description"n/aFixed Value. This is a placeholder element and presently not used by any of the 4 DHBs.
````````````condition_on_practice.code.valuestring0..1n/aThis is a placeholder element and presently not used by any of the 4 DHBs.
````````qualification.condition_on_practice.periodCodeableConcept1..1n/aThis is a placeholder element and presently not used by any of the 4 DHBs.
````````qualification.condition_on_practice.urluri1..1(see comments)n/aFixed Value: http://hl7.org.nz/fhir/StructureDefinition/scope-of-practice
````qualification.identifier[i]: RegistrationIdentifier0..*All DHBs
````````qualification.identifier.usecode1..1"official"All DHBsFixed Value
````````qualification.identifier.typeCodeableConcept0..1All DHBs
````````````qualification.identifier.type.coding.systemuri0..1(see comments)All DHBsFixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
````````````qualification.identifier.type.codecode0..1"MD"All DHBs
````````````qualification.identifier.type.displaystring0..1"Medical License number"All DHBs
```````````qualification.identifier.type.textstring0..1"Medical License number"All DHBs
````````qualification.identifier.systemuri0..1(see comments)All DHBsFixed Value: https://standards.digital.health.nz/ns/medical-council-id
````````qualification.identifier valuestring0..1"78864"All DHBs"If qualification.code.code is "MC" then the 5-digit value is a medical council number. For For CMH, NDHB and WDHB, if qualification.code.code is "NC", then the 6-digit value is a nursing council number."
````qualification.codeAll DHBs
````````qualification.code.systemuri0..1(see comments)All DHBsFixed Value: https://standards.digital.health.nz/id/hpi-organisation
````````qualification.code.codecode0..1"NC"All DHBs"For CMH, NDHB and WDHB, value can be null, "MC" or "NC"."
````````qualification.code.displaystring0..1"Nurse Council Number"All DHBs"For CMH, NDHB and WDHB, display can be null, "Medical Council Number" or "Nurse Council Number"."
````````qualification.code.textstring0..1"Nurse Council Number"All DHBsSame as display value.
````qualification.issuer0..1All DHBs
````````qualification.issuer.referenceReference {Organization}0..1"Organisation/NC"All DHBs"This is a string field that concatenates "Organisation/" and qualification.code.code."
````````qualification.issuer.identifierstring0..1n/aThis is a placeholder element and presently not used by any of the 4 DHBs.
```````qualification.issuer.identifier.textstring0..1n/aThis is a placeholder element and presently not used by any of the 4 DHBs.
communication[i]BackboneElement0..*All DHBsA language the practitioner can use in patient communication
````communication.languageCodeableConcept1..1All DHBs
````````communication.language.systemuri0..1urn:ietf:bcp:47All DHBsFixed Value
````````communication.language.codecode0..1"11"All DHBs"ADHB and NDHB uses numeric codes while CMH and WDHB are using alpha codes, example "FIJIAN"."
````````communication.language.displaystring0..1"Chinese - Teochoew"All DHBs
````````communication.language.textstring0..1"Chinese - Teochoew"All DHBsSame as display value.

Reviews